<?php

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *	   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * @package log4php
 */

/**
 * This is a very simple filter based on string matching.
 *
 * <p>The filter admits two options {@link $stringToMatch} and
 * {@link $acceptOnMatch}. If there is a match (using {@link PHP_MANUAL#strpos}
 * between the value of the {@link $stringToMatch} option and the message
 * of the {@link LoggerLoggingEvent},
 * then the {@link decide()} method returns {@link LoggerFilter::ACCEPT} if
 * the <b>AcceptOnMatch</b> option value is true, if it is false then
 * {@link LoggerFilter::DENY} is returned. If there is no match, {@link
 * LoggerFilter::NEUTRAL}
 * is returned.</p>
 *
 * <p>
 * An example for this filter:
 *
 * {@example ../../examples/php/filter_stringmatch.php 19}
 *
 * <p>
 * The corresponding XML file:
 *
 * {@example ../../examples/resources/filter_stringmatch.xml 18}
 *
 * @version $Revision: 1213283 $
 * @package log4php
 * @subpackage filters
 * @since 0.3
 */
class LoggerFilterStringMatch extends LoggerFilter
{

    /**
     *
     * @var boolean
     */
    protected $acceptOnMatch = true;

    /**
     *
     * @var string
     */
    protected $stringToMatch;

    /**
     *
     * @param mixed $acceptOnMatch
     *            a boolean or a string ('true' or 'false')
     */
    public function setAcceptOnMatch($acceptOnMatch)
    {
        $this->setBoolean('acceptOnMatch', $acceptOnMatch);
    }

    /**
     *
     * @param string $s
     *            the string to match
     */
    public function setStringToMatch($string)
    {
        $this->setString('stringToMatch', $string);
    }

    /**
     *
     * @return integer a {@link LOGGER_FILTER_NEUTRAL} is there is no string
     *         match.
     */
    public function decide(LoggerLoggingEvent $event)
    {
        $msg = $event->getRenderedMessage();
        
        if ($msg === null or $this->stringToMatch === null) {
            return LoggerFilter::NEUTRAL;
        }
        
        if (strpos($msg, $this->stringToMatch) !== false) {
            return ($this->acceptOnMatch) ? LoggerFilter::ACCEPT : LoggerFilter::DENY;
        }
        return LoggerFilter::NEUTRAL;
    }
}
